Microsoft Cognitive Language Service - Question Answering Authoring (preview:2025-05-15)

2025/05/05 • 21 new methods

QuestionAnsweringProjects_ListProjects (new)
Description :  Gets all projects for a user.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The QuestionAnsweringProjectMetadata items on this page ,
Required: True ,
}
[
{
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
language:
{
Description: Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
multilingualResource:
{
Description: Resource enabled for multiple languages across projects or not. ,
Required: False ,
}
boolean ,
settings:
{
Description: Configurable settings of the Project. ,
Required: False ,
}
{
defaultAnswer:
{
Description: Default Answer response when no good match is found in the knowledge base. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Project creation date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modified date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment date-time. ,
Format: date-time ,
Required: False ,
}
string ,
configureSemanticRanking:
{
Description: Represents if semantic ranking is configured. ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetProjectDetails (new)
Description :  Get the requested project metadata.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
language:
{
Description: Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
multilingualResource:
{
Description: Resource enabled for multiple languages across projects or not. ,
Required: False ,
}
boolean ,
settings:
{
Description: Configurable settings of the Project. ,
Required: False ,
}
{
defaultAnswer:
{
Description: Default Answer response when no good match is found in the knowledge base. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Project creation date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modified date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment date-time. ,
Format: date-time ,
Required: False ,
}
string ,
configureSemanticRanking:
{
Description: Represents if semantic ranking is configured. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_CreateProject (new)
Description :  Create or update a project.
Reference :  Link ¶

⚼ Request

PATCH:  /authoring/query-knowledgebases/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
language:
{
Description: Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
multilingualResource:
{
Description: Resource enabled for multiple languages across projects or not. ,
Required: False ,
}
boolean ,
settings:
{
Description: Configurable settings of the Project. ,
Required: False ,
}
{
defaultAnswer:
{
Description: Default Answer response when no good match is found in the knowledge base. ,
Required: False ,
}
string ,
}
,
configureSemanticRanking:
{
Description: Represents if semantic ranking is configured. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
language:
{
Description: Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
multilingualResource:
{
Description: Resource enabled for multiple languages across projects or not. ,
Required: False ,
}
boolean ,
settings:
{
Description: Configurable settings of the Project. ,
Required: False ,
}
{
defaultAnswer:
{
Description: Default Answer response when no good match is found in the knowledge base. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Project creation date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modified date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment date-time. ,
Format: date-time ,
Required: False ,
}
string ,
configureSemanticRanking:
{
Description: Represents if semantic ranking is configured. ,
Required: False ,
}
boolean ,
}

⚐ Response (201)

{
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
language:
{
Description: Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
multilingualResource:
{
Description: Resource enabled for multiple languages across projects or not. ,
Required: False ,
}
boolean ,
settings:
{
Description: Configurable settings of the Project. ,
Required: False ,
}
{
defaultAnswer:
{
Description: Default Answer response when no good match is found in the knowledge base. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Project creation date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modified date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment date-time. ,
Format: date-time ,
Required: False ,
}
string ,
configureSemanticRanking:
{
Description: Represents if semantic ranking is configured. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_DeleteProject (new)
Description :  Delete the project.
Reference :  Link ¶

⚼ Request

DELETE:  /authoring/query-knowledgebases/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_Export (new)
Description :  Export project metadata and assets.
Reference :  Link ¶

⚼ Request

POST:  /authoring/query-knowledgebases/projects/{projectName}/:export
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
format:
{
Description: Knowledge base Import or Export format. ,
Required: False ,
}
string ,
assetKind:
{
Description: Kind of the asset of the project. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_Import (new)
Description :  Import project assets.
Reference :  Link ¶

⚼ Request

POST:  /authoring/query-knowledgebases/projects/{projectName}/:import
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
format:
{
Description: Knowledge base Import or Export format. ,
Required: False ,
}
string ,
assetKind:
{
Description: Kind of the asset of the project. ,
Required: False ,
}
string ,
body:
{
Description: Project assets the needs to be imported. ,
Required: False ,
}
{
metadata:
{
Description: Parameters needed to create the project. ,
Required: False ,
}
{
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
description:
{
Description: Description of the project. ,
Required: False ,
}
string ,
language:
{
Description: Language of the text records. This is BCP-47 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
multilingualResource:
{
Description: Resource enabled for multiple languages across projects or not. ,
Required: False ,
}
boolean ,
settings:
{
Description: Configurable settings of the Project. ,
Required: False ,
}
{
defaultAnswer:
{
Description: Default Answer response when no good match is found in the knowledge base. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: Project creation date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modified date-time. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment date-time. ,
Format: date-time ,
Required: False ,
}
string ,
configureSemanticRanking:
{
Description: Represents if semantic ranking is configured. ,
Required: False ,
}
boolean ,
}
,
assets:
{
Description: All assets for this project. ,
Required: False ,
}
{
synonyms:
{
Description: Collection of synonyms. ,
Required: False ,
}
[
{
alterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
qnas:
{
Description: List of QnA records to import. ,
Required: False ,
}
[
{
id:
{
Description: Unique ID for the QnA. ,
Format: int32 ,
Required: True ,
}
integer ,
answer:
{
Description: Answer text. ,
Required: False ,
}
string ,
source:
{
Description: Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata associated with the answer, useful to categorize or filter question answers. ,
Required: False ,
}
object ,
dialog:
{
Description: Context of a QnA. ,
Required: False ,
}
{
isContextOnly:
{
Description: To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers. ,
Required: False ,
}
boolean ,
prompts:
{
Description: List of prompts associated with the answer. ,
Required: False ,
}
[
{
displayOrder:
{
Description: Index of the prompt. It is used for ordering of the prompts. ,
Format: int32 ,
Required: False ,
}
integer ,
qnaId:
{
Description: ID of the QnA corresponding to the prompt. ,
Format: int32 ,
Required: False ,
}
integer ,
qna:
{
Description: QnA record. Either QnAId or QnA record needs to be present in a Prompt. ,
Required: False ,
}
{
id:
{
Description: Unique ID for the QnA. ,
Format: int32 ,
Required: True ,
}
integer ,
answer:
{
Description: Answer text. ,
Required: False ,
}
string ,
source:
{
Description: Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata associated with the answer, useful to categorize or filter question answers. ,
Required: False ,
}
object ,
dialog:
{
Required: False ,
}
string ,
activeLearningSuggestions:
{
Description: List of Active Learning suggestions for the QnA. ,
Required: False ,
}
[
{
clusterHead:
{
Description: Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm. ,
Required: False ,
}
string ,
suggestedQuestions:
{
Description: List of all suggested questions for the QnA. ,
Required: False ,
}
[
{
question:
{
Description: Question suggested by the Active Learning feature. ,
Required: False ,
}
string ,
userSuggestedCount:
{
Description: The number of times the question was suggested explicitly by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
autoSuggestedCount:
{
Description: The number of times the question was suggested automatically by the Active Learning algorithm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
displayText:
{
Description: Text displayed to represent a follow up question prompt. ,
Required: False ,
}
string ,
}
,
]
,
}
,
activeLearningSuggestions:
{
Description: List of Active Learning suggestions for the QnA. ,
Required: False ,
}
[
{
clusterHead:
{
Description: Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm. ,
Required: False ,
}
string ,
suggestedQuestions:
{
Description: List of all suggested questions for the QnA. ,
Required: False ,
}
[
{
question:
{
Description: Question suggested by the Active Learning feature. ,
Required: False ,
}
string ,
userSuggestedCount:
{
Description: The number of times the question was suggested explicitly by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
autoSuggestedCount:
{
Description: The number of times the question was suggested automatically by the Active Learning algorithm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lastUpdatedDateTime:
{
Description: Date-time when the QnA was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
sourceDisplayName:
{
Description: Friendly name of the Source. ,
Required: False ,
}
string ,
}
,
]
,
}
,
fileUri:
{
Description: Import data File URI. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_ListDeployments (new)
Description :  List all deployments of a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/deployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The ProjectDeployment items on this page ,
Required: True ,
}
[
{
deploymentName:
{
Description: Name of the deployment. ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment date-time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_DeployProject (new)
Description :  Deploy project to production.
Reference :  Link ¶

⚼ Request

PUT:  /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetDeployStatus (new)
Description :  Gets the status of a Deploy job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Name of the deployment. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Job Status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetExportStatus (new)
Description :  Gets the status of an Export job, once job completes, returns the project metadata, and assets.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Job Status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
resultUrl:
{
Description: URL to download the result of the Export Job. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_AddFeedback (new)
Description :  Update Active Learning feedback.
Reference :  Link ¶

⚼ Request

POST:  /authoring/query-knowledgebases/projects/{projectName}/feedback
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: Feedback for Active Learning. ,
Required: True ,
}
{
records:
{
Description: A list of Feedback Records for Active Learning. ,
Required: False ,
}
[
{
userId:
{
Description: Unique identifier of the user. ,
Required: False ,
}
string ,
userQuestion:
{
Description: User suggested question for the QnA. ,
Required: False ,
}
string ,
qnaId:
{
Description: Unique ID of the QnA. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetImportStatus (new)
Description :  Gets the status of an Import job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Job Status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetQnas (new)
Description :  Gets all the QnAs of a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/qnas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
source:
{
Description: Source of the QnA. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RetrieveQnaRecord items on this page ,
Required: True ,
}
[
{
id:
{
Description: Unique ID for the QnA. ,
Format: int32 ,
Required: True ,
}
integer ,
answer:
{
Description: Answer text. ,
Required: False ,
}
string ,
source:
{
Description: Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata associated with the answer, useful to categorize or filter question answers. ,
Required: False ,
}
object ,
dialog:
{
Description: Context of a QnA. ,
Required: False ,
}
{
isContextOnly:
{
Description: To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers. ,
Required: False ,
}
boolean ,
prompts:
{
Description: List of prompts associated with the answer. ,
Required: False ,
}
[
{
displayOrder:
{
Description: Index of the prompt. It is used for ordering of the prompts. ,
Format: int32 ,
Required: False ,
}
integer ,
qnaId:
{
Description: ID of the QnA corresponding to the prompt. ,
Format: int32 ,
Required: False ,
}
integer ,
qna:
{
Description: QnA record. Either QnAId or QnA record needs to be present in a Prompt. ,
Required: False ,
}
{
id:
{
Description: Unique ID for the QnA. ,
Format: int32 ,
Required: True ,
}
integer ,
answer:
{
Description: Answer text. ,
Required: False ,
}
string ,
source:
{
Description: Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata associated with the answer, useful to categorize or filter question answers. ,
Required: False ,
}
object ,
dialog:
{
Required: False ,
}
string ,
activeLearningSuggestions:
{
Description: List of Active Learning suggestions for the QnA. ,
Required: False ,
}
[
{
clusterHead:
{
Description: Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm. ,
Required: False ,
}
string ,
suggestedQuestions:
{
Description: List of all suggested questions for the QnA. ,
Required: False ,
}
[
{
question:
{
Description: Question suggested by the Active Learning feature. ,
Required: False ,
}
string ,
userSuggestedCount:
{
Description: The number of times the question was suggested explicitly by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
autoSuggestedCount:
{
Description: The number of times the question was suggested automatically by the Active Learning algorithm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
displayText:
{
Description: Text displayed to represent a follow up question prompt. ,
Required: False ,
}
string ,
}
,
]
,
}
,
activeLearningSuggestions:
{
Description: List of Active Learning suggestions for the QnA. ,
Required: False ,
}
[
{
clusterHead:
{
Description: Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm. ,
Required: False ,
}
string ,
suggestedQuestions:
{
Description: List of all suggested questions for the QnA. ,
Required: False ,
}
[
{
question:
{
Description: Question suggested by the Active Learning feature. ,
Required: False ,
}
string ,
userSuggestedCount:
{
Description: The number of times the question was suggested explicitly by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
autoSuggestedCount:
{
Description: The number of times the question was suggested automatically by the Active Learning algorithm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
lastUpdatedDateTime:
{
Description: Date-time when the QnA was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_UpdateQnas (new)
Description :  Updates the QnAs of a project.
Reference :  Link ¶

⚼ Request

PATCH:  /authoring/query-knowledgebases/projects/{projectName}/qnas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: Update QnAs parameters of a project. ,
Required: True ,
}
{
op:
{
Description: Update operation type for assets. ,
Enum:
{
add: Add operation. ,
delete: Delete operation. ,
replace: Replace operation. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: QnA record. ,
Required: True ,
}
{
id:
{
Description: Unique ID for the QnA. ,
Format: int32 ,
Required: True ,
}
integer ,
answer:
{
Description: Answer text. ,
Required: False ,
}
string ,
source:
{
Description: Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: Metadata associated with the answer, useful to categorize or filter question answers. ,
Required: False ,
}
object ,
dialog:
{
Required: False ,
}
string ,
activeLearningSuggestions:
{
Description: List of Active Learning suggestions for the QnA. ,
Required: False ,
}
[
{
clusterHead:
{
Description: Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm. ,
Required: False ,
}
string ,
suggestedQuestions:
{
Description: List of all suggested questions for the QnA. ,
Required: False ,
}
[
{
question:
{
Description: Question suggested by the Active Learning feature. ,
Required: False ,
}
string ,
userSuggestedCount:
{
Description: The number of times the question was suggested explicitly by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
autoSuggestedCount:
{
Description: The number of times the question was suggested automatically by the Active Learning algorithm. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetUpdateQnasStatus (new)
Description :  Gets the status of update QnAs job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Job Status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetSources (new)
Description :  Gets all the sources of a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/sources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The QnaSourceRecord items on this page ,
Required: True ,
}
[
{
displayName:
{
Description: Friendly name of the Source. ,
Required: False ,
}
string ,
source:
{
Description: Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source. ,
Required: True ,
}
string ,
sourceUri:
{
Description: URI location for the file or url. ,
Format: uri ,
Required: True ,
}
string ,
sourceKind:
{
Description: Supported source types. ,
Enum:
{
file: File Source. ,
url: URI Source. ,
}
,
Required: True ,
}
enum ,
contentStructureKind:
{
Description: Content structure type for sources. ,
Enum:
{
unstructured: Unstructured. ,
}
,
Required: False ,
}
enum ,
lastUpdatedDateTime:
{
Description: Date-time when the QnA was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_UpdateSources (new)
Description :  Updates the sources of a project.
Reference :  Link ¶

⚼ Request

PATCH:  /authoring/query-knowledgebases/projects/{projectName}/sources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: Update sources parameters of a project. ,
Required: True ,
}
{
op:
{
Description: Update operation type for assets. ,
Enum:
{
add: Add operation. ,
delete: Delete operation. ,
replace: Replace operation. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Update source record. ,
Required: True ,
}
{
displayName:
{
Description: Friendly name of the Source. ,
Required: False ,
}
string ,
source:
{
Description: Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source. ,
Required: True ,
}
string ,
sourceUri:
{
Description: URI location for the file or url. ,
Format: uri ,
Required: True ,
}
string ,
sourceKind:
{
Description: Supported source types. ,
Enum:
{
file: File Source. ,
url: URI Source. ,
}
,
Required: True ,
}
enum ,
contentStructureKind:
{
Description: Content structure type for sources. ,
Enum:
{
unstructured: Unstructured. ,
}
,
Required: False ,
}
enum ,
refresh:
{
Description: Boolean flag used to refresh data from the Source. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetUpdateSourcesStatus (new)
Description :  Gets the status of update sources job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Job Status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetSynonyms (new)
Description :  Gets all the synonyms of a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/synonyms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: Name of the project. ,
Required: True ,
}
string ,
top:
{
Description: The maximum number of resources to return from the collection. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: An offset into the collection of the first resource to be returned. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of resources to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The WordAlterations items on this page ,
Required: True ,
}
[
{
alterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_UpdateSynonyms (new)
Description :  Updates all the synonyms of a project.
Reference :  Link ¶

⚼ Request

PUT:  /authoring/query-knowledgebases/projects/{projectName}/synonyms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: All the synonyms of a project. ,
Required: True ,
}
{
value:
{
Description: The WordAlterations items on this page ,
Required: True ,
}
[
{
alterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetDeleteStatus (new)
Description :  Gets the status of a Project delete job.
Reference :  Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/deletion-jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
status:
{
Description: Job Status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: Error response. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidArgument: Invalid argument error ,
Unauthorized: Unauthorized access error ,
Forbidden: Forbidden access error ,
NotFound: Not found error ,
ProjectNotFound: Project not found error ,
OperationNotFound: Operation not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchIndexNotFound: Azure Cognitive Search index not found error ,
TooManyRequests: Too many requests error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
AzureCognitiveSearchIndexLimitReached: Azure Cognitive Search index limit reached error ,
InternalServerError: Internal server error ,
ServiceUnavailable: Service unavailable error ,
Timeout: Timeout error ,
QuotaExceeded: Quota exceeded error ,
Conflict: Conflict error ,
Warning: Warning error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Enum:
{
InvalidRequest: Invalid request error ,
InvalidParameterValue: Invalid parameter value error ,
KnowledgeBaseNotFound: Knowledge base not found error ,
AzureCognitiveSearchNotFound: Azure Cognitive Search not found error ,
AzureCognitiveSearchThrottling: Azure Cognitive Search throttling error ,
ExtractionFailure: Extraction failure error ,
InvalidRequestBodyFormat: Invalid request body format error ,
EmptyRequest: Empty request error ,
MissingInputDocuments: Missing input documents error ,
InvalidDocument: Invalid document error ,
ModelVersionIncorrect: Model version incorrect error ,
InvalidDocumentBatch: Invalid document batch error ,
UnsupportedLanguageCode: Unsupported language code error ,
InvalidCountryHint: Invalid country hint error ,
}
,
Required: True ,
}
enum ,
message:
{
Description: Error message. ,
Required: True ,
}
string ,
details:
{
Description: Error details. ,
Required: False ,
}
object ,
target:
{
Description: Error target. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}